docs: improve docker README #3209
Conversation
ogunleye0720
requested review from
evan-forbes,
rootulp,
cmwaters,
staheri14 and
ninabarbakadze
as code owners
|
Warning Rate Limit Exceeded@ogunleye0720 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 3 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. WalkthroughThe Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
docker/README.md
Outdated
| ## 🐳 Docker setup | ||
|
|
||
| This documentation provides a step by step guide on how to start up a celestia | ||
| app using a docker image. Docker provides a seamless setup for celestia-app | ||
| in an isolated environment on your machine. With Docker, | ||
| you do not have to worry about the manual configuration of the required | ||
| dependencies, which can be a pain. | ||
|
|
There was a problem hiding this comment.
The introduction to the Docker setup section is clear and concise, effectively setting the stage for the detailed instructions that follow. However, consider using "step-by-step" (with hyphens) for better readability.
- step by step
+ step-by-stepCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ## 🐳 Docker setup | |
| This documentation provides a step by step guide on how to start up a celestia | |
| app using a docker image. Docker provides a seamless setup for celestia-app | |
| in an isolated environment on your machine. With Docker, | |
| you do not have to worry about the manual configuration of the required | |
| dependencies, which can be a pain. | |
| ## 🐳 Docker setup | |
| This documentation provides a step-by-step guide on how to start up a celestia | |
| app using a docker image. Docker provides a seamless setup for celestia-app | |
| in an isolated environment on your machine. With Docker, | |
| you do not have to worry about the manual configuration of the required | |
| dependencies, which can be a pain. | |
docker/README.md
Outdated
| 1. [Docker Setup](#docker-setup) | ||
| 2. [Overview of celestia-app txsim](#overview-of-celestial-app-txsim) | ||
| 3. [Prerequisites](#prerequisites) | ||
| 4. [Quick-Start](#quick-start) | ||
| 5. [Docker Compose](#docker-compose) | ||
| 6. [Kubernetes Deployments](#kubernetes-deployments) | ||
| 7. [Flag Breakdown](#flag-breakdown) |
There was a problem hiding this comment.
The Table of Contents is well-organized and provides a clear roadmap for the document. However, there's a minor typo in the link to the "Overview of celestia-app txsim" section. The correct anchor should match the section title exactly.
- 2. [Overview of celestia-app txsim](#overview-of-celestial-app-txsim)
+ 2. [Overview of celestia-app txsim](#overview-of-celestial-app-txsim)Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 1. [Docker Setup](#docker-setup) | |
| 2. [Overview of celestia-app txsim](#overview-of-celestial-app-txsim) | |
| 3. [Prerequisites](#prerequisites) | |
| 4. [Quick-Start](#quick-start) | |
| 5. [Docker Compose](#docker-compose) | |
| 6. [Kubernetes Deployments](#kubernetes-deployments) | |
| 7. [Flag Breakdown](#flag-breakdown) | |
| 1. [Docker Setup](#docker-setup) | |
| 2. [Overview of celestia-app txsim](#overview-of-celestial-app-txsim) | |
| 3. [Prerequisites](#prerequisites) | |
| 4. [Quick-Start](#quick-start) | |
| 5. [Docker Compose](#docker-compose) | |
| 6. [Kubernetes Deployments](#kubernetes-deployments) | |
| 7. [Flag Breakdown](#flag-breakdown) |
docker/README.md
Outdated
| This documentation provides a step by step guide on how to start up a celestia | ||
| app using a docker image. Docker provides a seamless setup for celestia-app | ||
| in an isolated environment on your machine. With Docker, | ||
| you do not have to worry about the manual configuration of the required | ||
| dependencies, which can be a pain. | ||
|
|
There was a problem hiding this comment.
The introduction to the Docker setup section is clear and concise. However, as previously noted in the comments from outdated commits, consider using "step-by-step" (with hyphens) for better readability.
- step by step
+ step-by-stepCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| This documentation provides a step by step guide on how to start up a celestia | |
| app using a docker image. Docker provides a seamless setup for celestia-app | |
| in an isolated environment on your machine. With Docker, | |
| you do not have to worry about the manual configuration of the required | |
| dependencies, which can be a pain. | |
| This documentation provides a step-by-step guide on how to start up a celestia | |
| app using a docker image. Docker provides a seamless setup for celestia-app | |
| in an isolated environment on your machine. With Docker, | |
| you do not have to worry about the manual configuration of the required | |
| dependencies, which can be a pain. | |
| - [Docker Desktop for Mac or Windows](https://docs.docker.com/get-docker) or | ||
| [Docker Engine for Linux](https://docs.docker.com/engine/install/) | ||
| and a basic understanding of Docker. |
There was a problem hiding this comment.
The prerequisites section clearly outlines the necessary tools and knowledge. However, there's an unpaired symbol in the markdown link for Docker Desktop. Ensure all markdown links are correctly formatted.
- - [Docker Desktop for Mac or Windows](https://docs.docker.com/get-docker) or
+ - [Docker Desktop for Mac or Windows](https://docs.docker.com/get-docker) orCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| - [Docker Desktop for Mac or Windows](https://docs.docker.com/get-docker) or | |
| [Docker Engine for Linux](https://docs.docker.com/engine/install/) | |
| and a basic understanding of Docker. | |
| - [Docker Desktop for Mac or Windows](https://docs.docker.com/get-docker) or | |
| [Docker Engine for Linux](https://docs.docker.com/engine/install/) | |
| and a basic understanding of Docker. |
| 3. Using a suitable text editor of your choice, open the | ||
| .celestia-app file and paste the keyring of the prefunded account. |
There was a problem hiding this comment.
When instructing users to paste the keyring into the .celestia-app file, avoid putting a space before the full stop to maintain consistency and professionalism in documentation.
- .celestia-app file and paste the keyring of the prefunded account.
+ .celestia-app file and paste the keyring of the prefunded account.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 3. Using a suitable text editor of your choice, open the | |
| .celestia-app file and paste the keyring of the prefunded account. | |
| 3. Using a suitable text editor of your choice, open the | |
| .celestia-app file and paste the keyring of the prefunded account. |
|
|
||
| Finally, you can run the `txsim` Docker image in a Kubernetes cluster. Here's an example `deployment.yaml` file: | ||
| Congratulations! You have successfuly set up celestia-app in Docker 😎. |
There was a problem hiding this comment.
The congratulatory message for successfully setting up the Celestia app in Docker contains a spelling mistake. Correct "successfuly" to "successfully" to maintain professionalism in the documentation.
- Congratulations! You have successfuly set up celestia-app in Docker 😎.
+ Congratulations! You have successfully set up celestia-app in Docker 😎.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| Congratulations! You have successfuly set up celestia-app in Docker 😎. | |
| Congratulations! You have successfully set up celestia-app in Docker 😎. |
rootulp
changed the title
|
Hello @rootulp Do let me know if there are any changes to be made. |
| -r http://consensus-validator-robusta-rc6.celestia-robusta.com:26657, \ | ||
| http://consensus-full-robusta-rc6.celestia-robusta.com:26657 \ |
There was a problem hiding this comment.
We can get rid of these two lines, as the tx sim no longer requires an rpc endpoint and the -r flag has been removed
| 3. Using a suitable text editor of your choice, open the | ||
| .celestia-app file and paste the keyring of the prefunded account. |
There was a problem hiding this comment.
I think it would be helpful here to tell people how they can setup the keyring using the celestia-appd keys subcommand. For example celestia-appd keys add txsim would create the key and print the mnemonic. That way you can either paste the mnemonic as a flag or copy the keyring directory across
| | FLAG | DESCRIPTION | DEFAULT | OPTION | | ||
| | ---- | ---- | ---- | :----: | | ||
| |`-k`|Whether a new key should be created|0|1 for yes, 0 for no| | ||
| |`-p`|Path to keyring for prefunded account|-|-| | ||
| |`-g`|gRPC endpoint|consensus-validator-robusta-rc6.celestia-robusta.com:9090|| | ||
| |`-t`|Poll time for the `txsim` binary|10s|1s,2s,3s,4s,...| | ||
| |`-b`|Number of blob sequences to run|10|any integer value(1,2,3,...)| | ||
| |`-a`|Range of blobs to send per PFB in a sequence|-|-| | ||
| |`-s`|Range of blob sizes to send|-|-| | ||
| |`-m`|Mnemonic for the keyring |-|-| | ||
| |`-d`|Seed for the random number generator|100|any integer value (1,2,3,...)| | ||
| |`-e`|Number of send sequences to run|10|any integer value (1,2,3,...)| | ||
| |`-i`|Amount to send from one account to another|-|any integer value (1,2,3,...)| | ||
| |`-v`|Number of send iterations to run per sequence|-|any integer value (1,2,3,...)| | ||
| |`-u`|Number of stake sequences to run|-|any integer value (1,2,3,...)| | ||
| |`-w`|Amount of initial stake per sequence|-|any integer value (1,2,3,...)| |
There was a problem hiding this comment.
👍 I like the use of the table
| The `txsim` binary is a tool that can be used to simulate transactions on the Celestia network. It can be used to test the performance of the Celestia network. | ||
| This guide provides instructions on how to use the Celestia `txsim` Docker image. The `txsim` Docker image is designed to run the `txsim` binary with a variety of configurable options. |
There was a problem hiding this comment.
I think this is helpful as an opening sentence about this README document
|
@ogunleye0720 markdownlint is failing: https://github.com/celestiaorg/celestia-app/actions/runs/8402250437/job/23035947714?pr=3209 Can you please fix the violations? You can run markdownlint locally via |
|
Going to close this b/c it doesn't appear to be actively worked on. Thanks for attempting to contribute @ogunleye0720! Please re-open if you address feedback. |
Hello @rootulp I spent the weekend working on the docs/node/docker.md repository. I will jump on this during the weekend. I also have a job, so I get very busy during the week. |
|
No problem and no rush from our side |
Overview
The Celestia app docker Readme.md file has been modified to enhance easy deployment in Docker and Kubernetes.
Checklist